home *** CD-ROM | disk | FTP | other *** search
/ EnigmA Amiga Run 1995 October / EnigmA AMIGA RUN 01 (1995)(G.R. Edizioni)(IT)[!][issue 1995-10][Aminet 7].iso / Aminet / comm / fido / FQUERY.lha / DOCS / FQ.readme < prev    next >
Text File  |  1995-04-20  |  7KB  |  150 lines
  1. Short: FQuery the Complete FileFInd for the Amiga
  2. Uploader: robert_williamson@p0.f104.n167.z1.fidonet.org
  3. Author: robert_williamson@p0.f104.n167.z1.fidonet.org (Robert Williamson)
  4. Type: comm/fido
  5.  
  6.     In  1991,  the  msdos  program ALLFIX, by Harald Harms,
  7.      "introduced the idea of searching for files via echomail. The term
  8.      applied to this function is 'FileFind'. The FileFind system allows
  9.      BBS USERS to search for files by placing a message to 'ALLFIX' and
  10.      wait for a reply.  Each  BBS system, running an  ALLFIX compatible
  11.      FileFind  processor,  will  reply to that  USER if there any files
  12.      matching their requested filespec."
  13.                     Quote from ALLFIX.DOC v4.20 by Harald Harms
  14.  
  15.   FQuery is the only _COMPLETE_ FileFind system for the Amiga, with ALL
  16.   the  user and operator features of AllFix as well as many, many more.
  17.   FQuery  processes  either PACKETS or MSG type echomail bases.  FQuery
  18.   accepts  messages addressed to FQuery, FileQuery, FileFind or AllFix.
  19.   FQuery ALSO processes NetMail messages addressed to FQuery.
  20.  
  21.   FQuery  supports  multiple networks and may be configured for as many
  22.   scan and reply echos as you need.  FQuery features _extremely_ strict
  23.   query processing and full file descriptions in the response.
  24.  
  25.   Two  versions  are  included,  for  either PACKET or MSG scanning.  A
  26.   keyfile  is  required to enable the posting of response messages.  At
  27.   this time there is NO CHARGE for the keyfile.
  28.  
  29.     Features:
  30.     *  indicates  a  standard  AllFix  feature.  Note that in some cases,
  31.        these items may be global only in AllFix.  
  32.     @  indicates item is configurable on a per-echo basis.
  33.     -  indicates feature introduced by FQuery
  34.  
  35.       * does NOT require a FREQ list
  36.      @* can respond in SCANNED ECHO or in a DESIGNATED FILEFIND REPLY ECHO
  37.         for the network if responses are disallowed in the scanned echo.
  38.      @- DESIGNATED REPLY ECHO can be in a differnt FTN.   
  39.      @- can respond via NETMAIL ONLY if preferred.
  40.      @* user can request a SECOND REPLY by replying to the response.
  41.      @* maximum  length  of matches and length of match list per message
  42.      @- limit of number of response messages.
  43.       * exclusion of LOCALLY generated query messages from processing.
  44.      @* search exclusion based upon AGE of MESSAGES.
  45.      @- KEYWORD and single word DESCRIPTION search exclusions based on
  46.         certain KEYWORDS defined as illegal.
  47.      @* search exclusions based upon lengths of FILESPECS and KEYWORDS
  48.      @- search exclusions based upon number of words and length of single
  49.         word DESCRIPTION queries.
  50.       - user can request that the response be returned via NETMAIL.
  51.       - processes and responds to NETMAIL QUERIES and COMMANDS.
  52.       - can send system ABOUT/MAGIC and NEWFILES via NETMAIL on request.
  53.      @- can be set to send response via netmail if response exceeds a 
  54.         preset size or number of messages.
  55.       - an echo MODERATOR can request a copy of the CONFIGURATION for
  56.         any echo via netmail.
  57.       - options to display GLOBAL configuration, ECHO configuration
  58.         and TEST queries with either the  defaults or the configure for
  59.         any particular scan echo.
  60.   
  61.   FQuery  has  an  FTSC  product  code  (DAx)  and is the ONLY FileFind
  62.   utility for the Amiga that is FULLY compliant with the following FTSC
  63.   specifications and proposals:
  64.  
  65.   FTS-0001  Format of packets and MSGs. FMPT, TOPT and INTL, dupe detection
  66.   FTS-0004  Transmitted form of EchoMail. PATH, SEENBY and ORIGIN.
  67.   FTS-0009  Message identification and reply linkage.  MSGID:, REPLY:, dupe detection
  68.   FSC-0039  Type 2+ packet extension proposal. 4d packet format.
  69.   FSC-0046  Proposed product identifier.  PID: and TEARLINE.
  70.   FSC-nnnn  Implementation and Usage of FileFind Utilities 
  71.  
  72.   Requirements:
  73.         o a volume assignment of CFG:
  74.         o Amiga OS Release 3 (may work with 2.04 and 2.1, not tested)
  75.         o A filelist with filename entries starting in column 2, that is;
  76.           each is preceeded by a single space.  This seems to be the most
  77.           common format. Utilties are included to check and convert
  78.           non-compliant filelists.
  79.  
  80.   Optional:
  81.         o MSG version:
  82.           The Tosser must not modify file attributes, nor strip message
  83.           attributes of imported .MSGs while exporting.
  84.           A configurable netmail management utility to call FQuery with
  85.           the  fullpath  and host address of the netmail FQuery message
  86.           if one is received.
  87.           NetMail messages can  still be processed manually if this  is
  88.           not  available.
  89.           The Packet version does not require a NetMail Manager.
  90.         o PKT  version:
  91.           The  ability to call FQscan either before importing, or after
  92.           backing up inbound packets.
  93.  
  94.   How to get it:
  95.  
  96.     FREQ or DL the MAGIC NAMES:    FQ or FQUERY
  97.     From:       FIDONET#1:167/104.0 or AMIGANET#40:600/104.0.
  98.  
  99.   You  will  receive  an  archive  containing FQueryP, FQueryM, FQscan,
  100.   FQCheckList,  FQFixList, the documentation, specification and example
  101.   config files.  
  102.  
  103.   You must be sure that FQuery WORKS for you.  The unregistered version
  104.   does EVERTHING except create outgoing packets.  The outbound response
  105.   messages  are displayed in the CLI instead.  You may capture these to
  106.   a file and examine them to be sure that the messages are proper.
  107.  
  108.   You  can  also  use  the TEST function to test various queries and be
  109.   sure that your filelist is in the expected format to produce properly
  110.   formatted response messages.
  111.  
  112.   FQuery  expects that file entries in your filelist start in column 2,
  113.   in other words, each filename is preceeded with a space.  FQuery will
  114.   treat ALL text lines that are preceeded with a single space as a file
  115.   entry.  It will ignore lines that have a character in column 1 or are
  116.   not  description  continuation  lines  as defined by the DESC_NUM and
  117.   DESC_COL entries in your config.
  118.  
  119.   The  utility  FQCheckList can be used to scan your filelist.  It will
  120.   output  some statistics with which you may determine if your filelist
  121.   is  compliant  with  FQuery  requirements.  It takes as arguments the
  122.   fullpathname   of  your  filelist,  the  start  column  of  the  file
  123.   description and the word number in the line of the description.
  124.  
  125.   Another  method  to  test  for  filelist compliance is to issue the
  126.   commands:
  127.  
  128.         SetEnv FQSEARCH DESC_COL-1,DESC_NUM ;use the actual values
  129.                                             ;not the variable names    
  130.         FQsearch FullPathNameOfFileList #? -f
  131.  
  132.   The  output  should  display all the file entries from your filelist,
  133.   properly formatted.
  134.       
  135.   IF  and  ONLY  if,  you  find that FQuery meets your needs, request a
  136.   keyfile   via   ROUTED   or  crash  netmail,  including  your  TESTED
  137.   configuration  in  the  message.   If you are accepted as a user, you
  138.   will  be  notifed  by ROUTED netmail.  Your keyfile will be placed on
  139.   hold for you in an archive with your name.
  140.  
  141.   Whenever  the source is changed a new FQuery archive will be created,
  142.   containing  the  current version.  Updated archives are automatically
  143.   placed on hold and a netmail message sent to each registered user.
  144.  
  145.   If  you  have  any  additional  questions on the requirements, either
  146.   NETMAIL  them  to  me  at  either address or post them in the FidoNet
  147.   echos  AMIGA_FIND  or FALCON_CBCS or the AmigaNet echos NETDEV_AMY or
  148.   FIND_AMY.
  149.  
  150.